home *** CD-ROM | disk | FTP | other *** search
/ Aminet 15 / Aminet 15 - Nov 1996.iso / Aminet / dev / gcc / ixemsdk.lha / man / cat2 / getrlimit.0 < prev    next >
Text File  |  1996-09-01  |  5KB  |  115 lines
  1.  
  2. GETRLIMIT(2)               UNIX Programmer's Manual               GETRLIMIT(2)
  3.  
  4. NNAAMMEE
  5.      ggeettrrlliimmiitt, sseettrrlliimmiitt - control maximum system resource consumption
  6.  
  7. SSYYNNOOPPSSIISS
  8.      ##iinncclluuddee <<ssyyss//ttyyppeess..hh>>
  9.      ##iinncclluuddee <<ssyyss//ttiimmee..hh>>
  10.      ##iinncclluuddee <<ssyyss//rreessoouurrccee..hh>>
  11.  
  12.      _i_n_t
  13.      ggeettrrlliimmiitt(_i_n_t _r_e_s_o_u_r_c_e, _s_t_r_u_c_t _r_l_i_m_i_t _*_r_l_p)
  14.  
  15.      _i_n_t
  16.      sseettrrlliimmiitt(_i_n_t _r_e_s_o_u_r_c_e, _s_t_r_u_c_t _r_l_i_m_i_t _*_r_l_p)
  17.  
  18. DDEESSCCRRIIPPTTIIOONN
  19.      Limits on the consumption of system resources by the current process and
  20.      each process it creates may be obtained with the ggeettrrlliimmiitt() call, and
  21.      set with the sseettrrlliimmiitt() call.
  22.  
  23.      The _r_e_s_o_u_r_c_e parameter is one of the following:
  24.  
  25.      RLIMIT_CORE     The largest size (in bytes) core file that may be creat-
  26.                      ed.
  27.  
  28.      RLIMIT_CPU      The maximum amount of cpu time (in seconds) to be used by
  29.                      each process.
  30.  
  31.      RLIMIT_DATA     The maximum size (in bytes) of the data segment for a
  32.                      process; this defines how far a program may extend its
  33.                      break with the sbrk(2) system call.
  34.  
  35.      RLIMIT_FSIZE    The largest size (in bytes) file that may be created.
  36.  
  37.      RLIMIT_MEMLOCK  The maximum size (in bytes) which a process may lock into
  38.                      memory using the mlock(2) function.
  39.  
  40.      RLIMIT_NOFILE   The maximum number of open files for this process.
  41.  
  42.      RLIMIT_NPROC    The maximum number of simultaneous processes for this us-
  43.                      er id.
  44.  
  45.      RLIMIT_RSS      The maximum size (in bytes) to which a process's resident
  46.                      set size may grow.  This imposes a limit on the amount of
  47.                      physical memory to be given to a process; if memory is
  48.                      tight, the system will prefer to take memory from pro-
  49.                      cesses that are exceeding their declared resident set
  50.                      size.
  51.  
  52.      RLIMIT_STACK    The maximum size (in bytes) of the stack segment for a
  53.                      process; this defines how far a program's stack segment
  54.                      may be extended.  Stack extension is performed automati-
  55.                      cally by the system.
  56.  
  57.      A resource limit is specified as a soft limit and a hard limit.  When a
  58.      soft limit is exceeded a process may receive a signal (for example, if
  59.      the cpu time or file size is exceeded), but it will be allowed to contin-
  60.      ue execution until it reaches the hard limit (or modifies its resource
  61.      limit).  The _r_l_i_m_i_t structure is used to specify the hard and soft limits
  62.      on a resource,
  63.  
  64.            struct rlimit {
  65.                    rlim_t  rlim_cur;       /* current (soft) limit */
  66.                    rlim_t  rlim_max;       /* hard limit */
  67.            };
  68.  
  69.      Only the super-user may raise the maximum limits.  Other users may only
  70.      alter _r_l_i_m___c_u_r within the range from 0 to _r_l_i_m___m_a_x or (irreversibly) low-
  71.      er _r_l_i_m___m_a_x.
  72.  
  73.      An ``infinite'' value for a limit is defined as RLIM_INFINITY.
  74.  
  75.      Because this information is stored in the per-process information, this
  76.      system call must be executed directly by the shell if it is to affect all
  77.      future processes created by the shell; lliimmiitt is thus a built-in command
  78.      to csh(1).
  79.  
  80.      The system refuses to extend the data or stack space when the limits
  81.      would be exceeded in the normal way: a break call fails if the data space
  82.      limit is reached.  When the stack limit is reached, the process receives
  83.      a segmentation fault (SIGSEGV); if this signal is not caught by a handler
  84.      using the signal stack, this signal will kill the process.
  85.  
  86.      A file I/O operation that would create a file larger that the process'
  87.      soft limit will cause the write to fail and a signal SIGXFSZ to be gener-
  88.      ated; this normally terminates the process, but may be caught.  When the
  89.      soft cpu time limit is exceeded, a signal SIGXCPU is sent to the offend-
  90.      ing process.
  91.  
  92. RREETTUURRNN VVAALLUUEESS
  93.      A 0 return value indicates that the call succeeded, changing or returning
  94.      the resource limit.   A return value of -1 indicates that an error oc-
  95.      curred, and an error code is stored in the global location _e_r_r_n_o.
  96.  
  97. EERRRROORRSS
  98.      GGeettrrlliimmiitt() and sseettrrlliimmiitt() will fail if:
  99.  
  100.      [EFAULT]      The address specified for _r_l_p is invalid.
  101.  
  102.      [EPERM]       The limit specified to sseettrrlliimmiitt() would have raised the
  103.                    maximum limit value, and the caller is not the super-user.
  104.  
  105. SSEEEE AALLSSOO
  106.      csh(1),  quota(2),  sigaction(2),  sigaltstack(2),  sysctl(3)
  107.  
  108. BBUUGGSS
  109.      There should be lliimmiitt and uunnlliimmiitt commands in sh(1) as well as in csh.
  110.  
  111. HHIISSTTOORRYY
  112.      The ggeettrrlliimmiitt() function call appeared in 4.2BSD.
  113.  
  114. 4th Berkeley Distribution        June 4, 1993                                2
  115.